home *** CD-ROM | disk | FTP | other *** search
/ JCSM Shareware Collection 1996 September / JCSM Shareware Collection (JCS Distribution) (September 1996).ISO / prgtools / vndinf10.zip / GUIDE.DOC < prev    next >
Text File  |  1994-02-28  |  35KB  |  945 lines
  1.  
  2.     
  3.  
  4.  
  5.  
  6.  
  7.                   +----------------------------------------+
  8.                   |                                        |
  9.                   |                                        |
  10.                   |      Introduction and Guide to the     |
  11.                   |                                        |
  12.                   |              VENDINFO(TM)              |
  13.                   |       Product Information System       |
  14.                   |     and VENDINFO.DIZ File Standard     |
  15.                   |              Version 1.00              |
  16.                   |                                        |
  17.                   |                                        |
  18.                   |      Last updated: February 1994       |
  19.                   |                                        |
  20.                   |                                        |
  21.                   | Copyright 1993-4 Rams' Island Software |
  22.                   |          All rights reserved           |
  23.                   |                                        |
  24.                   +----------------------------------------+
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.    Rams' Island Software
  45.    7644 E. Lakecliff Way                   _______
  46.    Parker, CO 80134-5904 (USA)        ____|__     |                (R)
  47.                                    --|       |    |-------------------
  48.    Voice: (303) 841-2848             |   ____|__  |  Association of
  49.    BBS:   (303) 841-6269             |  |       |_|  Shareware
  50.    CompuServe: 76244,324             |__|   o   |    Professionals
  51.                                    -----|   |   |---------------------
  52.    FidoNet:  1:104/333                  |___|___|    MEMBER
  53.    RIME:     1235
  54.    Internet: 76244.324@compuserve.com
  55.  
  56.  
  57.                                                                            
  58.  
  59.  
  60.  
  61.  
  62.    Guide to VENDINFO                                      Table of Contents
  63.  
  64.  
  65.                              +-------------------+
  66.                              | Table of Contents |
  67.                              +-------------------+
  68.  
  69.  
  70.     The VENDINFO System ................................................  1
  71.        Components of the System ........................................  1
  72.        Structure of a VENDINFO File ....................................  2
  73.        A Little Background .............................................  3
  74.        Industry Support and Endorsements ...............................  4
  75.        Other VENDINFO Documents and Packages ...........................  5
  76.  
  77.     A Few Concrete Examples ............................................  6
  78.        Content of a VENDINFO File ......................................  6
  79.        Extraction of FILES.BBS Information .............................  8
  80.        A Distribution Permission Decision ..............................  8
  81.        Automatic Routing of Packages ................................... 10
  82.        Automatic Permission Requests ................................... 11
  83.  
  84.     Guide to the Standard .............................................. 12
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.    VENDINFO System v1.00             -ii-                          Feb 1994
  117.  
  118.  
  119.  
  120.  
  121.  
  122.    Guide to VENDINFO                               Introduction to VENDINFO
  123.  
  124.  
  125.     
  126.                             +---------------------+
  127.                             | The VENDINFO System |
  128.                             +---------------------+
  129.  
  130.       VENDINFO is a system for conveying software product information and
  131.       distribution permissions from the author to distributors. A standard
  132.       (public) file format allows a VENDINFO.DIZ file to carry extensive
  133.       information in a compressed, efficient form. The associated toolset
  134.       aids the author in constructing the record, and allows the dis-
  135.       tributor to extract portions of the record, or to make distribution
  136.       decisions based on its content, in a highly automated way.
  137.  
  138.       VENDINFO provides unprecedented capabilities for
  139.  
  140.            o  Communication of product information and distribution
  141.               policies from author to distributor.
  142.  
  143.            o  Automation of many aspects of package handling by shareware
  144.               distributors of all types.
  145.  
  146.  
  147.  
  148.    Components of the System
  149.    ------------------------
  150.  
  151.       The VENDINFO "record" is the key. This is an efficiently compressed
  152.       file (VENDINFO.DIZ) containing a great deal of information about the
  153.       product, the author, and the product's distribution policies.
  154.  
  155.       The VendEdit editor allows the author to construct a complete
  156.       VENDINFO record in just a few minutes, assuming that the necessary
  157.       descriptive texts have already been prepared.
  158.  
  159.       The VendPrcs (pronounced "vend process") processor is a batch program
  160.       allowing automated decisions based on VENDINFO content, and automated
  161.       extraction of VENDINFO information.
  162.  
  163.       VendView is a simple viewer allowing the end-user to see relevant
  164.       portions of the VENDINFO data. This program should be available by
  165.       February 1994. Even without VendView, an ordinary text viewer will
  166.       display a good deal of useful information.
  167.  
  168.       The Product Registry is a collection of VENDINFO records available
  169.       for searches and queries by subscription, BBS login, or mail-order
  170.       query. This service will begin in January 1994.
  171.  
  172.       The VendLib Library allows software developers to build VENDINFO
  173.       access directly into such products as BBS programs and upload proces-
  174.  
  175.  
  176.    VENDINFO System v1.00              -1-                          Feb 1994
  177.  
  178.  
  179.  
  180.  
  181.    Guide to VENDINFO                               Introduction to VENDINFO
  182.  
  183.  
  184.       sors. This library is already in the hands of some 30 vendors of
  185.       BBSes, BBS utility software, and other relevant software.
  186.  
  187.       The file-format standard describing the VENDINFO file is public, and
  188.       draft versions have been published since July 1993. The final version
  189.       1.00 has been released, and is the basis for the current toolset.
  190.  
  191.       VendPrcs Plus, a non-shareware version of VendPrcs, is planned for
  192.       release by Spring 1994. It will have a full-screen interface, using
  193.       scripts for easier, more efficient information extraction, and
  194.       templates for easier description of decision situations. It will also
  195.       allow management of a library of VENDINFO files, and will provide
  196.       automated access to the Product Registry BBS.
  197.  
  198.       Additional services for authors, users, and distributors are under
  199.       consideration.
  200.  
  201.  
  202.    Structure of a VENDINFO File
  203.    ----------------------------
  204.  
  205.       The VENDINFO.DIZ file contains two sections. A human-readable front
  206.       section contains information about how to use the VENDINFO file, and
  207.       presents most of the basic information about the product in readable
  208.       form.
  209.  
  210.       The second section is a binary data record, compressed with a PKZIP
  211.       1.10 algorithm, and appended to the file after the first section.
  212.       This record has some 750 fields of information about such things as
  213.  
  214.            o  Product name, date, and version
  215.  
  216.            o  Preferred package filename, other parts of product, replaced
  217.               versions
  218.  
  219.            o  Product descriptions of varying length, categories, keywords
  220.  
  221.            o  Required platform (CPU, operating system, memory, disk,
  222.               features)
  223.  
  224.            o  Contact information for author, for registering, for tech
  225.               support
  226.  
  227.            o  Registration prices and benefits, acceptable forms of payment
  228.  
  229.            o  Warranty and trial-use license
  230.  
  231.            o  Detailed distribution policy, in general and by distribution
  232.               channel
  233.  
  234.  
  235.    VENDINFO System v1.00              -2-                          Feb 1994
  236.  
  237.  
  238.  
  239.  
  240.    Guide to VENDINFO                               Introduction to VENDINFO
  241.  
  242.  
  243.            o  Information about regional distributors and registration
  244.               services.
  245.  
  246.  
  247.  
  248.    A Little Background
  249.    -------------------
  250.  
  251.       The author of the VENDINFO standard and tools, Rudy Ramsey, has been
  252.       agitating since early 1992 for the development of an improved
  253.       mechanism for conveying product information and permissions from
  254.       authors to distributors. Initially, the intent was to make this a
  255.       purely volunteer-based effort, probably conducted within the auspices
  256.       of the Association of Shareware Professionals. However, others were
  257.       slow to respond to the idea (with the exception of Richard Holler and
  258.       Fred Hill), and it gradually became clear that it would have to be
  259.       done as an "extracurricular" effort, if at all.
  260.  
  261.       In the Spring of 1993, Rudy began the VENDINFO effort in earnest, by
  262.       preparing the CONCEPT.DOC concept paper and distributing it to a few
  263.       key shareware industry figures for comment. (At this time, he still
  264.       imagined VENDINFO as an all-volunteer effort.) The reviewers were
  265.       uniformly excited about the idea, and greatly encouraging. Most felt
  266.       that it was an idea whose time had come, and that the technical
  267.       approach described in the concept paper was very appropriate.
  268.  
  269.       Their second response, however, was that the effort contained the
  270.       seeds of its own failure. It might provide all the necessary incen-
  271.       tives for participation by authors, distributors, and users. But if
  272.       it didn't also provide an incentive for continued development and
  273.       support by its own development team, it would fail. It was simply too
  274.       big an activity for successful execution by volunteers.
  275.  
  276.       As a result of that input, a decision was made to regard VENDINFO as
  277.       partly a business opportunity. Although this makes a few people
  278.       suspicious, most agree it's in the best interest of the VENDINFO
  279.       effort itself, and of the industry. In fact, VENDINFO has developed
  280.       rapidly, partly because it has been a full-time focus of its author
  281.       for many months. That wouldn't have been possible in an all-volunteer
  282.       effort.
  283.  
  284.       The VENDINFO file-format standard is public. A substantial period was
  285.       provided for public comment on the concept paper, and then on the
  286.       standard, and public input is always welcome. Some of the tools that
  287.       make use of the standard are free (a viewer for end users, and the
  288.       processor when used by single-line, noncommercial BBSes). Most are
  289.       low-cost shareware. There will also be much-enhanced, non-shareware
  290.       programs later, for special purposes, but none of them are necessary
  291.       to achieve the benefits of the VENDINFO system.
  292.  
  293.  
  294.    VENDINFO System v1.00              -3-                          Feb 1994
  295.  
  296.  
  297.  
  298.  
  299.    Guide to VENDINFO                               Introduction to VENDINFO
  300.  
  301.  
  302.    Industry Support and Endorsements
  303.    ---------------------------------
  304.  
  305.       Support for the VENDINFO concept has been extraordinarily high
  306.       throughout the industry. Authors, disk vendors, CD-ROM publishers,
  307.       Sysops, and BBS software manufacturers have all expressed their
  308.       support, and many have pledged to build VENDINFO capability into
  309.       their own software products.
  310.  
  311.       The following shareware trade groups have formally endorsed the
  312.       VENDINFO file-format standard as a means of conveying product and
  313.       product-distribution information from authors to users and dis-
  314.       tributors.
  315.  
  316.          Association of Shareware Professionals (ASP)
  317.          Shareware Trade Association and Resources (STAR)
  318.          Association of Shareware Authors and Developers (ASAD)
  319.          Educational Software CoOperative (ESC)
  320.  
  321.       The ASP has licensed the VENDINFO toolset for use by all 1700 of its
  322.       members. This will greatly accelerate the use -- and the usefulness
  323.       -- of VENDINFO.
  324.  
  325.       The following software manufacturers have "committed in principle" to
  326.       support VENDINFO in their own software offerings by mid-1994. In the
  327.       context of these products, "support" for VENDINFO means extracting
  328.       relevant descriptive information automatically from VENDINFO files.
  329.       It does not necessarily mean making decisions based on the product's
  330.       distribution policy. VendPrcs will provide that capability.
  331.  
  332.          BBSes
  333.  
  334.             PCBoard, Clark Development Co.
  335.             Wildcat!, Mustang Software, Inc.
  336.             Major BBS, Galacticomm
  337.             RBBS, RBBS Development Team
  338.             Searchlight BBS, Searchlight Software
  339.             TBBS, eSoft
  340.             Auntie BBS, Wes Meier
  341.             Executive Host BBS, Steve Wood
  342.             MainLine BBS, Scott Green, City Limits Software
  343.             OmegaComm BBS, Larry Loiselle
  344.             PowerBBS for Windows, Russell Frey
  345.             ProBoard BBS, Philippe Leybaert
  346.             Sapphire BBS, Pinnacle Software
  347.             Tinyhost, Bruce Krobusek
  348.             UltraBBS, UltraBBS Software
  349.             Windowed Modem Environment, Jason Fesler
  350.  
  351.  
  352.  
  353.    VENDINFO System v1.00              -4-                          Feb 1994
  354.  
  355.  
  356.  
  357.  
  358.    Guide to VENDINFO                               Introduction to VENDINFO
  359.  
  360.  
  361.          File Upload Processors
  362.  
  363.             CatScan, Mike Ortiz
  364.             CheckZip, Bill Hull
  365.             DIZIT, Robert Neal/CorpSoft
  366.             HoboScan, Floyd Hobson
  367.             TransScan, Craig Dunstan
  368.  
  369.          File Distribution Processors
  370.  
  371.             WCFF, Online Computer Resources
  372.  
  373.          Other Products
  374.  
  375.            *BBSee Disk Cataloger, Martin Vallevand
  376.           **Catalog-on-a-Disk, EmmaSoft Software Company, Inc.
  377.             Colorado Utilities Disk Manager, Micro Systems Solutions
  378.           **SmartCat Disk Cataloger, Oakley Data Services
  379.  
  380.        * Test versions are known to exist which support VENDINFO
  381.       ** Released products support VENDINFO
  382.  
  383.  
  384.    Other VENDINFO Documents and Packages
  385.    -------------------------------------
  386.  
  387.       The VENDINFO idea is documented in a concept paper and in the VEN-
  388.       DINFO file-format standard. These two documents are available in the
  389.       VENDINFO package, usually named VNDINFxx.ZIP. It can be obtained from
  390.       the Rams' Island BBS on first login or by FidoNet or RIME file re-
  391.       quest (magic name VENDINFO). It is also available in the CompuServe
  392.       SHAREWARE and UKSHARE forums; the ASP Hub Network BBSes, many local
  393.       BBSes, from some disk vendors, and on the ASP CD-ROM.
  394.  
  395.       If necessary, the concept paper and evaluation versions of the basic
  396.       toolset can be obtained on diskette from Rams' Island Software for
  397.       US$ 8.00 plus $2.00 shipping and handling in North America, $4.00
  398.       elsewhere (starting January 1994). Payment is accepted by
  399.       Visa/MasterCard, check in U.S. dollars drawn on a U.S. bank, cash in
  400.       any hard currency (registered mail suggested), and various other
  401.       forms.
  402.  
  403.       An article about the VENDINFO system is scheduled to appear in the
  404.       now-delayed November/December 1993 issue of Shareware Magazine.
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.    VENDINFO System v1.00              -5-                          Feb 1994
  413.  
  414.  
  415.  
  416.  
  417.    Guide to VENDINFO                                               Examples
  418.  
  419.  
  420.        
  421.                           +-------------------------+
  422.                           | A Few Concrete Examples |
  423.                           +-------------------------+
  424.  
  425.       Concrete examples are often easier to assimilate than abstract ideas,
  426.       and can convey lots of detailed understanding in a small package.
  427.       This section will therefore present a few such examples. Keep in
  428.       mind, though, that these examples are being presented without com-
  429.       plete explanation, to help you understand the overall idea. You
  430.       should not expect to understand every detail.
  431.  
  432.       The examples presented below are representative, but don't begin to
  433.       exhaust the capabilities of the VENDINFO system.
  434.  
  435.  
  436.    Content of a VENDINFO File
  437.    --------------------------
  438.  
  439.       To give an idea of some of the information in a VENDINFO.DIZ file, a
  440.       sample is shown below. This sample was produced by a simple batch
  441.       file that uses the VendPrcs processor to extract individual informa-
  442.       tion fields from the VENDINFO.DIZ file. Here's one line of the batch
  443.       file, which extracts the product version:
  444.  
  445.          vendprcs VENDINFO.DIZ -xpv -y " Version: @"
  446.  
  447.       Here's a VERY SMALL FRACTION of the output of the batch file, and
  448.       therefore of the content of the VENDINFO.DIZ file:
  449.  
  450.                        Product Information
  451.             Product Type: Software
  452.             Product Name: InContext
  453.           Name Extension: Work Environment Manager
  454.                  Version: 1.10
  455.                     Date: 1/31/93
  456.           Version Reason: Major new release, with many feature enhancements
  457.          Filename Prefix: INCXT11
  458.          Number of Parts: 2
  459.                This Part: INCXT11A
  460.            List of Parts: INCXT11A INCXT11B
  461.         CompuServe Parts: INCXTA INCXTB
  462.         Screenshot Types: PCX CGM FLM
  463.                 Replaced: INCX102A INCX102B
  464.            Description 1:
  465.                 InContext Work Environment Manager V1.10 <ASP>
  466.            ...
  467.            Description 4: InContext(TM) Work Environment Manager V1.10
  468.                           Part 1 of 2 <ASP>. Complete Work Environment
  469.  
  470.  
  471.    VENDINFO System v1.00              -6-                          Feb 1994
  472.  
  473.  
  474.  
  475.  
  476.    Guide to VENDINFO                                               Examples
  477.  
  478.  
  479.                           Manager for expert PC users. Automates more
  480.                           aspects of the PC user's work than any other
  481.                           product. Designed by a PhD ergonomist, it is
  482.                           based on fundamental principles of how people
  483.                           actually work. Much more than a DOS shell.
  484.                           NEW VERSION 1.10 has Gantt charts, multi-file
  485.                           tagging, 4DOS long descriptions, PKZIP 2.04
  486.                           support, *many* new features.
  487.            ...
  488.            Description 6:
  489.            ...
  490.                 Keywords: Work Environment Manager Object Oriented DOS
  491.                           Shell Calendar Project
  492.  
  493.       Platform Information (highly abbreviated)
  494.        Minimal Platform
  495.                      CPU: Intel 8086/8088
  496.                Op System: MS-DOS 3.0
  497.               Std Memory: 512K
  498.           Disk Min Instl: 1000K
  499.        Features
  500.         Config:   Laptop: Supported
  501.         RAM:         EMS: Supported
  502.         Disk: Hard Drive: Required
  503.         Disk:  Flop Only: Won't Work
  504.         Disk:     CD-ROM: Supported
  505.  
  506.       Author Information
  507.              Author Name: H. Rudy Ramsey
  508.             Company Name: Rams' Island Software
  509.                  Address: 7644 E. Lakecliff Way
  510.                           Parker, CO  80134-5904
  511.                           USA
  512.             Author Phone: 303-841-2848
  513.            Queries Phone: 303-841-2848
  514.                 BBS Name: Rams' Island BBS
  515.                BBS Phone: 303-841-6269
  516.             BBS Username: Rudy Ramsey
  517.               CompuServe: 76244,324
  518.                  FidoNet: 1:104/333
  519.                 Internet: 76244.324@compuserve.com
  520.                     RIME: RAMSISLE
  521.         Known Trade Assn: ASP STAR
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.    VENDINFO System v1.00              -7-                          Feb 1994
  531.  
  532.  
  533.  
  534.  
  535.    Guide to VENDINFO                                               Examples
  536.  
  537.  
  538.    Extraction of FILES.BBS Information
  539.    -----------------------------------
  540.  
  541.       BBS Sysops often keep lists of their files in a particular descrip-
  542.       tive form known as FILES.BBS. Many BBS and BBS utility manufacturers
  543.       have committed to import VENDINFO information directly into their
  544.       files databases, but it will still be useful to show the construction
  545.       of a FILES.BBS description using a batch file.
  546.  
  547.       Here's an example of a FILES.BBS description, truncated on the right
  548.       to fit here:
  549.  
  550.          INCXT11D.ZIP  216251 1/31/93   InContext(TM) Work Environment Mana
  551.                                         Part 1 of 2 <ASP>. Complete Work En
  552.                                         Manager for expert PC users. Automa
  553.                                         aspects of the PC user's work than
  554.                                         product. Designed by a PhD ergonomi
  555.                                         based on fundamental principles of
  556.                                         actually work. Much more than a DOS
  557.                                         NEW VERSION 1.10 has Gantt charts,
  558.                                         tagging, 4DOS long descriptions, PK
  559.                                         support, *many* new features.
  560.  
  561.       Here's the working part of a simple batch file, which constructed the
  562.       description above. This example uses the VendPrcs processor, with
  563.       various command-line flags, to extract each of the fields of informa-
  564.       tion that make up a FILES.BBS entry.
  565.  
  566.          vendprcs -p .\INCXT11D.ZIP -xxpf -zw12 -zn
  567.          vendprcs -p .\INCXT11D.ZIP -xxps -zw8  -zn -zl
  568.          vendprcs                   -y " "      -zn
  569.          vendprcs -p .\INCXT11D.ZIP -xxpd -zw9  -zn -zd "mm/dd/yy"
  570.          vendprcs VENDINFO.DIZ      -xpd4 -zi31 -zc45 -y " @"
  571.  
  572.       In plain English, the first command above says "write the package
  573.       filename of the compressed package .\INCXT11D.ZIP, padding to a width
  574.       of 12 characters, and not writing a newline."
  575.  
  576.  
  577.    A Distribution Permission Decision
  578.    ----------------------------------
  579.  
  580.       In this example, a CD-ROM publisher wishes to select, from a large
  581.       set of programs, all those that satisfy two criteria:
  582.  
  583.            o  Distribution by BBS is totally unlimited.
  584.  
  585.            o  Distribution on a $40 CD-ROM is allowed, possibly subject to
  586.               additional requirements.
  587.  
  588.  
  589.    VENDINFO System v1.00              -8-                          Feb 1994
  590.  
  591.  
  592.  
  593.  
  594.    Guide to VENDINFO                                               Examples
  595.  
  596.  
  597.       The result will be a candidate set of programs for a CD-ROM that can
  598.       be sold strictly to BBS sysops, for on-line access via BBS.
  599.  
  600.       Shown below is the working portion of a simple batch file that per-
  601.       forms this function. The batch file leaves a copy of the package in
  602.       one of several directories, as defined in the batch file itself and
  603.       in VPRESULT.CFG, along with a correspondingly named LOG file.
  604.  
  605.          pkunzip %1 vendinfo.diz
  606.          if not exist vendinfo.diz goto manual
  607.  
  608.          rem ----- reject BBS-limited products --------------------------
  609.          vendprcs vendinfo.diz -db
  610.          if errorlevel 40 goto bbsok
  611.          if errorlevel 20 goto reject
  612.          goto bad_vendinfo
  613.  
  614.          :bbsok
  615.          rem ----- now test for CD-ROM distributability -----------------
  616.          vendprcs vendinfo.diz -dc -cc40 -mcb -rmnd -p .\%1
  617.          goto done
  618.  
  619.       Here's a portion of a log file produced by a distribution test, to
  620.       give you an idea what information it might contain:
  621.  
  622.       VendPrcs 1.00 Copyright 1993 Rams' Island Software, Parker, CO USA
  623.       UNREGISTERED COPY: If used past 30-day evaluation period, registration
  624.                          is required.  Registration is free for single-line,
  625.                          strictly non-commercial BBSes.
  626.  
  627.         Testing: C:\RUDY\SWDEV\VENDINFO\VENDEDIT\INCXT11A\VENDINFO.DIZ
  628.                  InContext Work Environment Manager v1.10
  629.                  Rams' Island Software
  630.  
  631.             for: Distribution to End User by Mail-Order Disk Vendor
  632.                  Contents checked against Packing List for ALLOWED CHANGES
  633.  
  634.         but not: VENDINFO record(s) not checked for authenticity/validity
  635.  
  636.         Mods:    Author requires *all* original, unchanged files be present
  637.                  Entire package is as released by author
  638.  
  639.         Quals:   Would "qualify" if ASP distributor member           [-ta]
  640.                  Would "qualify" if customer fully informed      [-oipods]
  641.                  Would "qualify" if user group                       [-tu]
  642.                  Would "qualify" if non-profit user group            [-tn]
  643.                  Would "qualify" if package was received from author [-or]
  644.  
  645.         Disqual: Charge per product not <= US$ 10.00            [-cp<amt>]
  646.  
  647.  
  648.    VENDINFO System v1.00              -9-                          Feb 1994
  649.  
  650.  
  651.  
  652.  
  653.    Guide to VENDINFO                                               Examples
  654.  
  655.  
  656.                  Charge per 360K not <= US$ 10.00               [-ck<amt>]
  657.                  (Eliminating disquals removes requirement for permission)
  658.  
  659.         Note:    All rights not expressly granted are reserved to the
  660.                  author.  The author may revoke any permissions granted
  661.                  here, by notifying you in writing.
  662.  
  663.         AddlReq: Written permission is required, and not obtained    [-op]
  664.  
  665.       DISTRIBUTION WOULD BE ALLOWED if written permission obtained
  666.  
  667.  
  668.  
  669.    Automatic Routing of Packages
  670.    -----------------------------
  671.  
  672.       In this example, a BBS sysop wants to automatically route packages
  673.       depending on their subject matter. To do this, he prepares a
  674.       VPCATGRY.CFG file based on the category scheme used by VENDINFO.
  675.       Here's a section of the CATEGORY.INF file that comes with VENDINFO:
  676.  
  677.          14000000 Business
  678.             14010000 Business finances
  679.                14010100 Business accounting
  680.                14010200 Point-of-sale systems
  681.                14010300 Billing systems
  682.                14010400 Purchase order systems
  683.                14010500 Payroll systems
  684.             14020000 Inventory systems
  685.             14140000 Equipment use & maintenance
  686.             14040000 Project management
  687.                14040100 Project bidding & costing
  688.                   14040101 Decision analysis tools
  689.                14040200 Project scheduling
  690.  
  691.       Here's a segment of a VPCATGRY.CFG file used to do automated file
  692.       routing:
  693.  
  694.          00000000 Reject
  695.          14000000 C:\BBSFILES\BUSINESS
  696.             14010000 C:\BBSFILES\FINANCE
  697.             14040000 C:\BBSFILES\PROJMAN
  698.  
  699.       Given this file, the command
  700.  
  701.          vendprcs vendinfo.diz -p <package_name> -rcn
  702.  
  703.       will move the package to the correct directory. There's a little more
  704.       detail involved, but this conveys the basic idea.
  705.  
  706.  
  707.    VENDINFO System v1.00             -10-                          Feb 1994
  708.  
  709.  
  710.  
  711.  
  712.    Guide to VENDINFO                                               Examples
  713.  
  714.  
  715.    Automatic Permission Requests
  716.    -----------------------------
  717.  
  718.       This example shows automated production of a letter to an author from
  719.       a disk vendor, describing the vendor's company and requesting permis-
  720.       sion to distribute the author's product. It is also possible to
  721.       automatically construct electronic mail messages in this way. Here's
  722.       a segment of a batch file, to illustrate the idea. This batch file
  723.       produces a text file (LETTER.TXT) suitable for use with Ventura
  724.       Publisher to print the letter on existing company letterhead.
  725.  
  726.          vendprcs %1 -xac -y "@@AUTHOR = @"             > letter.txt
  727.          vendprcs -y " "                               >> letter.txt
  728.          vendprcs %1 -xaa -y "@@ADDRESS = @" -zv       >> letter.txt
  729.          vendprcs -y " "                               >> letter.txt
  730.          echo Dear Author:                             >> letter.txt
  731.          vendprcs -y " "                               >> letter.txt
  732.  
  733.          echo We have recently received a copy of your >> letter.txt
  734.          vendprcs %1 -xpp -y "<B>@" -zn                >> letter.txt
  735.          vendprcs %1 -xpe           -zn                >> letter.txt
  736.          vendprcs %1 -xpv -y "v@<D>."                  >> letter.txt
  737.          vendprcs -y " "                               >> letter.txt
  738.  
  739.          echo We are quite interested in adding this   >> letter.txt
  740.          echo program to our inventory, but we observe >> letter.txt
  741.          echo that you require written permission...   >> letter.txt
  742.          vendprcs -y " "                               >> letter.txt
  743.  
  744.          echo This letter will serve to introduce you  >> letter.txt
  745.          echo to our business, and...                  >> letter.txt
  746.          vendprcs -y " "                               >> letter.txt
  747.  
  748.          echo @CLOSING = Yours truly,                  >> letter.txt
  749.          vendprcs -y " "                               >> letter.txt
  750.          vendprcs -y "@SIGNATURE = Ima D. Vendor"      >> letter.txt
  751.  
  752.       A similar application of these techniques could produce a catalog
  753.       entry for a disk vendor's mail-order catalog.
  754.  
  755.  
  756.  
  757.  
  758.  
  759.  
  760.  
  761.  
  762.  
  763.  
  764.  
  765.  
  766.    VENDINFO System v1.00             -11-                          Feb 1994
  767.  
  768.  
  769.  
  770.  
  771.    Guide to VENDINFO                                  Guide to the Standard
  772.  
  773.  
  774.        
  775.                            +-----------------------+
  776.                            | Guide to the Standard |
  777.                            +-----------------------+
  778.  
  779.       The actual VENDINFO file-format standard is contained in a separate
  780.       document in this package. In this package, the standard is named
  781.       STANDARD.DOC, since its purpose here is to document the standard. In
  782.       another context (the software library underlying the VENDINFO tools),
  783.       the identical file is called VENDINFO.H (following the C-language
  784.       naming convention for "include" files).
  785.  
  786.       STANDARD.DOC is fully self-contained, but makes for rather tedious
  787.       reading, since it mainly documents the rather complex structure of
  788.       the VENDINFO.DIZ file. It is also presented in a somewhat awkward
  789.       (for human readers) order, since the file doubles as a compiler-
  790.       readable definition of the structure. Some compilers require that the
  791.       "building blocks" (substructures) be defined first, and then used to
  792.       construct the main structure. Thus, the definitions are somewhat
  793.       bottom-up in STANDARD.DOC.
  794.  
  795.       A much more natural order for human readers is a top-down approach,
  796.       and this brief chapter will try to provide a top-down overview, as an
  797.       aid to reading STANDARD.DOC.
  798.  
  799.       The VENDINFO.DIZ file consists of two parts. The first part is a
  800.       human-readable text section terminated by a control-Z character. This
  801.       text section is readable by ordinary text viewers, including BBS on-
  802.       line in-ZIP vieweres, and the control-Z character causes most of them
  803.       to stop displaying at the end of this information.
  804.  
  805.       The second part of the file is a compressed VENDINFO data record. In
  806.       order to access this information, it is necessary to use a PKZIP
  807.       v1.10-or-later decompression algorithm to expand it into its uncom-
  808.       pressed form. Most of STANDARD.DOC is devoted to defining the struc-
  809.       ture of this data record.
  810.  
  811.       The data record has the following overall structure (see "VENDINFO
  812.       Main Record Structure", which is around page 44 of STANDARD.DOC):
  813.          Header
  814.          Product
  815.          Author
  816.          Order
  817.          Prices
  818.          Support
  819.          General
  820.          Distribution
  821.          Extensions
  822.  
  823.  
  824.  
  825.    VENDINFO System v1.00             -12-                          Feb 1994
  826.  
  827.  
  828.  
  829.  
  830.    Guide to VENDINFO                                  Guide to the Standard
  831.  
  832.  
  833.       The Header section contains information about the VENDINFO file
  834.       itself, including size and CRC of the text and data sections, and
  835.       several other elements of the security envelope.
  836.  
  837.       The Product section contains about 100 fields of information about
  838.       the product. Included are various names, version and release date,
  839.       descriptions, categories, keywords, etc. A substantial subsection of
  840.       this information describes the minimum and required hardware/software
  841.       platforms and any additional platform features that are relevant to
  842.       the product.
  843.  
  844.       The Author section contains some 25 fields of information about the
  845.       author or publisher of the product, including mail, phone, and
  846.       electronic contact information.
  847.  
  848.       The Order section contains similar contact information for ordering
  849.       registered versions. This may or may not be the same as the author
  850.       contact information. In addition, the section provides detailed
  851.       information about acceptable forms of payment.
  852.  
  853.       The Prices section contains some 96 fields of information about
  854.       product prices and registration benefits.
  855.  
  856.       The Support section contains contact information for obtaining tech-
  857.       nical support. This may or may not be the same as the author or
  858.       ordering contact information.
  859.  
  860.       The General section describes the channel-independent portion of the
  861.       product's distribution policy. This includes, for example, permitted
  862.       modifications to the product.
  863.  
  864.       The Distribution section contains a detailed statement of distribu-
  865.       tion policy for each of 13 different distribution channels.
  866.  
  867.       In addition to all of the above, which makes up the fixed-length
  868.       portion of the data record, there may be any number of record exten-
  869.       sions. Each of these contains information about an "Other Distributor
  870.       of Registered Version", including contact information, services
  871.       offered, and acceptable forms of payment.
  872.  
  873.       STANDARD.DOC also contains the draft definition of a much shorter
  874.       VENDINFO "executable branding" record that will be developed and
  875.       finalized later in 1994. This record will allow executables, OBJ, LIB
  876.       and DLL files, and maybe many other things, to be branded with iden-
  877.       tifying information and the product's distribution policy. That will,
  878.       in turn, allow automatic detection of individual files that should
  879.       not be distributed by a particular vendor or BBS.
  880.  
  881.       Throughout STANDARD.DOC are various requirements that must be met by
  882.  
  883.  
  884.    VENDINFO System v1.00             -13-                          Feb 1994
  885.  
  886.  
  887.  
  888.  
  889.    Guide to VENDINFO                                  Guide to the Standard
  890.  
  891.  
  892.       any VENDINFO-related tools. Many of these requirements are important
  893.       to the smooth functioning of the VENDINFO system. If you are develop-
  894.       ing tools that will create or use VENDINFO records, it is important
  895.       that you read through the entire document and make sure that your
  896.       tool is fully compliant.
  897.  
  898.       With this introduction, any software developer should be able to read
  899.       and understand STANDARD.DOC fairly easily. ular vendor or BBS.
  900.  
  901.  
  902.  
  903.  
  904.  
  905.  
  906.  
  907.  
  908.  
  909.  
  910.  
  911.  
  912.  
  913.  
  914.  
  915.  
  916.  
  917.  
  918.  
  919.  
  920.  
  921.  
  922.  
  923.  
  924.  
  925.  
  926.  
  927.  
  928.  
  929.  
  930.  
  931.  
  932.  
  933.  
  934.  
  935.  
  936.  
  937.  
  938.  
  939.  
  940.  
  941.  
  942.  
  943.    VENDINFO System v1.00             -14-                          Feb 1994
  944.  
  945.